-
-
Notifications
You must be signed in to change notification settings - Fork 4.4k
feat(onboarding): Add logs to react router onboarding #97438
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Comment on lines
214
to
216
Sentry.logger.info("User triggered test error", { | ||
'action': SentryLogAttribute.string('test_loader_error'), | ||
});` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Potential bug: The React Router onboarding doc uses an undefined `SentryLogAttribute`, which will cause a `ReferenceError` and crash the user's application during verification.
- Description: The code in the React Router getting started documentation at
Sentry.logger.info
usesSentryLogAttribute.string('test_loader_error')
. TheSentryLogAttribute
object is not defined in the Sentry JavaScript SDK or imported anywhere in the codebase. When a user copies and executes this code snippet during the onboarding verification step, their application will throw aReferenceError: SentryLogAttribute is not defined
. This crash prevents users from successfully verifying their Sentry setup for React Router when logs are enabled, breaking a key part of the onboarding flow. - Suggested fix: Remove the call to the undefined
SentryLogAttribute.string()
wrapper. The value for theaction
key should be a plain string, like'test_loader_error'
, consistent with other JavaScript onboarding documentation and the Sentry SDK's API.
severity: 0.8, confidence: 1.0
Did we get this right? 👍 / 👎 to inform future reviews.
chargome
approved these changes
Aug 8, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🙏
AbhiPrasad
commented
Aug 8, 2025
andrewshie-sentry
pushed a commit
that referenced
this pull request
Aug 12, 2025
resolves https://linear.app/getsentry/issue/LOGS-249/add-logs-to-react-router-onboarding resolves https://linear.app/getsentry/issue/LOGS-290/add-verify-steps-to-react-router-js-onboarding also adds tests and cleans up snippet code adding. Should match https://docs.sentry.io/platforms/javascript/guides/react-router/ better now.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
resolves https://linear.app/getsentry/issue/LOGS-249/add-logs-to-react-router-onboarding
resolves https://linear.app/getsentry/issue/LOGS-290/add-verify-steps-to-react-router-js-onboarding
also adds tests and cleans up snippet code adding. Should match https://docs.sentry.io/platforms/javascript/guides/react-router/ better now.